<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilskey: zynqmp bbram</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilskey
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xilskey__zynq_m_p.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">zynqmp bbram</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa1cc8606083a1c20933361fa4d7920c4"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilskey__zynq_m_p.html#gaa1cc8606083a1c20933361fa4d7920c4">XilSKey_ZynqMp_Bbram_Program</a> (const u32 *AesKey)</td></tr>
<tr class="memdesc:gaa1cc8606083a1c20933361fa4d7920c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function implements the BBRAM programming and verifying the key written.  <a href="#gaa1cc8606083a1c20933361fa4d7920c4">More...</a><br/></td></tr>
<tr class="separator:gaa1cc8606083a1c20933361fa4d7920c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab6c727d0448cd7281c282300b72f6152"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilskey__zynq_m_p.html#gab6c727d0448cd7281c282300b72f6152">XilSKey_ZynqMp_Bbram_Zeroise</a> (void)</td></tr>
<tr class="memdesc:gab6c727d0448cd7281c282300b72f6152"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function zeroize's Bbram Key.  <a href="#gab6c727d0448cd7281c282300b72f6152">More...</a><br/></td></tr>
<tr class="separator:gab6c727d0448cd7281c282300b72f6152"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaa1cc8606083a1c20933361fa4d7920c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XilSKey_ZynqMp_Bbram_Program </td>
          <td>(</td>
          <td class="paramtype">const u32 *&#160;</td>
          <td class="paramname"><em>AesKey</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function implements the BBRAM programming and verifying the key written. </p>
<p>Program and verification of AES will work only together. CRC of the provided key will be calculated internally and verified after programming.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">AesKey</td><td>Pointer to the key which has to be programmed.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Error code from XskZynqMp_Ps_Bbram_ErrorCodes enum if it fails</li>
<li>XST_SUCCESS if programming is done. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#ad460c32a4f02c48d7c3cb6ea7f3e4a48">XSK_ZYNQMP_BBRAM_0_OFFSET</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#a104c26f1c18fe3998ea71013bc2c0d0c">XSK_ZYNQMP_BBRAM_7_OFFSET</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#ac621f36f217dcc74ee918df67cebaa5d">XSK_ZYNQMP_BBRAM_AES_CRC_OFFSET</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#a7fd7c9a4f6f4012f7e4581608d9be7d4">XSK_ZYNQMP_BBRAM_BASEADDR</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#ad4d9fa44c9d798cf462ce82cdddcd913">XSK_ZYNQMP_BBRAM_STS_AES_CRC_DONE_MASK</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#a908f302a42c8b8c7333259b183e043c9">XSK_ZYNQMP_BBRAM_STS_AES_CRC_PASS_MASK</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#a194a83c890440a26af4abfbb73dcea7d">XSK_ZYNQMP_BBRAM_STS_OFFSET</a>, <a class="el" href="group__xilskey__zmpsoc__ps__error__codes.html#gga43029ac3b786e9f57cc8674f065a53e6a903e134a762730cccfe345331d94c28e">XSK_ZYNQMP_BBRAMPS_ERROR_IN_CRC_CHECK</a>, <a class="el" href="group__xilskey__zmpsoc__ps__error__codes.html#gga43029ac3b786e9f57cc8674f065a53e6a1a75b454a6c9327b9d801727f45779fa">XSK_ZYNQMP_BBRAMPS_ERROR_IN_PRGRMG</a>, and <a class="el" href="group__xilskey__zmpsoc__ps__error__codes.html#gga43029ac3b786e9f57cc8674f065a53e6a7bb31a479b446803f07ae3d69b093e77">XSK_ZYNQMP_BBRAMPS_ERROR_IN_WRITE_CRC</a>.</p>

</div>
</div>
<a class="anchor" id="gab6c727d0448cd7281c282300b72f6152"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XilSKey_ZynqMp_Bbram_Zeroise </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function zeroize's Bbram Key. </p>
<dl class="section note"><dt>Note</dt><dd>BBRAM key will be zeroized. </dd></dl>

<p>References <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#ad460c32a4f02c48d7c3cb6ea7f3e4a48">XSK_ZYNQMP_BBRAM_0_OFFSET</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#a104c26f1c18fe3998ea71013bc2c0d0c">XSK_ZYNQMP_BBRAM_7_OFFSET</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#a7fd7c9a4f6f4012f7e4581608d9be7d4">XSK_ZYNQMP_BBRAM_BASEADDR</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#a7a4d3e383cfd97b8eedcd6c5203fd51f">XSK_ZYNQMP_BBRAM_CTRL_OFFSET</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#afd1d1dd32d28ba076e06ff0bcc58e2a1">XSK_ZYNQMP_BBRAM_CTRL_ZEROIZE_MASK</a>, <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#a194a83c890440a26af4abfbb73dcea7d">XSK_ZYNQMP_BBRAM_STS_OFFSET</a>, and <a class="el" href="xilskey__bbramps__zynqmp__hw_8h.html#a725e7bf31bc0af974326c225d9b78669">XSK_ZYNQMP_BBRAM_STS_ZEROIZED_MASK</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
